bwapi 1.0.0

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

@@ -0,0 +1,67 @@
+module BWAPI
+  class Client
+    module Projects
+      module Queries
+        module DateRange
+
+          # Get all date ranges for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @return [Hashie::Mash] All date ranges for query
+          def date_ranges project_id, query_id
+            get "projects/#{project_id}/#{query_id}/date-range"
+          end
+
+          # Get specific date range for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param date_range_id [Integer] Id of date range
+          # @return [Hashie::Mash] Specific date range for query
+          def date_range project_id, query_id, date_range_id
+            get "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}"
+          end
+
+          # Create a new date range for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] projectId Id of the project
+          # @option opts [Integer] queryId Id of the query
+          # @option opts [Array] StoredDateRangeDTO Date ranges to be stored
+          # @return [Hashie::Mash] New date range
+          def create_date_range project_id, query_id, opts
+            post "projects/#{project_id}/#{query_id}/date-range", opts
+          end
+
+          # Update an existing date range for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] projectId Id of the project
+          # @option opts [Integer] queryId Id of the query
+          # @option opts [Integer] dateRangeId Id of the date range
+          # @option opts [Array] StoredDateRangeDTO Date ranges to be edited
+          # @return [Hashie::Mash] Update date range
+          def update_date_range project_id, query_id, opts
+            put "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}", opts
+          end
+
+          # Delete an existing date range for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param date_range_id [Integer] Id of date range
+          # @return [Hashie::Mash] Deleted date range
+          def delete_date_range project_id, query_id, date_range_id
+             delete "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}"
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module BWAPI
+  class Client
+    module Projects
+      module Queries
+        module Mentions
+
+          # Get the full text of query mention
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param mention_id [Integer] Id of mention
+          # @return [Hashie::Mash] Content of query mention
+          def get_query_mention_content project_id, query_id, mention_id
+            get "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}/content"
+          end
+          alias :query_mention_content :get_query_mention_content
+          alias :mention_content :get_query_mention_content
+
+          # Update query mention
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param mention_id [Integer] Id of mention
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] projectId Id of the project
+          # @option opts [Integer] queryId Id of the query
+          # @option opts [Integer] id Id of the mention
+          # @option opts [Hash] MentionPatchDTO patch to be applied
+          # @return [Hashie::Mash] Updated query mention
+          def update_query_mention project_id, query_id, mention_id, opts
+            patch "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
+          end
+
+          # Delete query mention
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param mention_id [Integer] Id of mention
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] projectId Id of the project
+          # @option opts [Integer] queryId Id of the query
+          # @option opts [Integer] id Id of the mention
+          # @option opts [Hash] Map patch to be applied
+          # @return [Hashie::Mash] Deleted query mention
+          def delete_query_mention project_id, query_id, mention_id, opts
+            delete "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module BWAPI
+  class Client
+    module Projects
+      module QueryGroups
+
+        # Get all query groups in project
+        #
+        # @param id [Integer] Id of project
+        # @option opts [Integer] page Page of projects to retrieve
+        # @option opts [Integer] pageSize Results per page of results
+        # @return [Hashie::Mash] All query groups in project
+        def query_groups id, opts={}
+          get "projects/#{id}/querygroups", opts
+        end
+
+        # Get a specific query group in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_group_id [Integer] Id of query group
+        # @return [Hashie::Mash] Specific query group
+        def get_query_group project_id, query_group_id
+          get "projects/#{project_id}/querygroups/#{query_group_id}"
+        end
+        alias :query_group :get_query_group
+
+        # Create a new query group in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query group
+        # @option opts [String] name Name of the query group
+        # @option opts [String] shared Shared mode of query group
+        # @option opts [Array] users Users which this query group belongs to
+        # @option opts [Array] queries Queries within the query group
+        # @option opts [Hash] sharedProjectIds Projects which this query group belongs to
+        # @return [Hashie::Mash] New query group
+        def create_query_group id
+          post "projects/#{project_id}/querygroups"
+        end
+
+        # Update an existing query group in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_group_id [Integer] Id of query group
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Integer] queryGroupId of the query group
+        # @option opts [String] name Name of the query group
+        # @option opts [String] shared Shared mode of query group
+        # @option opts [Array] users Users which this query group belongs to
+        # @option opts [Array] queries Queries within the query group
+        # @option opts [Hash] sharedProjectIds Projects which this query group belongs to
+        # @return [Hashie::Mash] New query group
+        def update_query_group project_id, query_group_id, opts={}
+          put "projects/#{project_id}/querygroups/#{query_group_id}", opts
+        end
+
+        # Delete an existing query group in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_group_id [Integer] Id of query group
+        # @return [Hashie::Mash] Deleted query group
+        def delete_query_group project_id, query_group_id
+          delete "projects/#{project_id}/querygroups/#{query_group_id}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module BWAPI
+  class Client
+    module Projects
+      module Sharing
+
+        # Default shares of a project
+        #
+        # @return [Hashie::Mash] Default project shares information
+        def default_project_sharing
+          get "projects/sharing"
+        end
+        alias :sharing :default_project_sharing
+
+        # Shares of a project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @options opt [Integer] id Id of the project
+        # @options opt [Boolean] sharedOnly Boolean flag to return only shared shares (default: false)
+        # @return [Hashie::Mash] Specific project shares
+        def project_sharing id, opts={}
+          get "projects/#{id}/sharing", opts
+        end
+
+        # Update shares of a project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @options opt [Integer] id Id of the project
+        # @options opt [Array] ProjectShareDTO Shares to be edited
+        # @return [Hashie::Mash] Updated project shares
+        def update_project_sharing id, opts={}
+          put "projects/#{id}/sharing", opts
+        end
+
+        # User share of a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param user_id [Integer] Id of user
+        # @return [Hashie::Mash] Share of project for user
+        def project_sharing_user project_id, user_id
+          get "projects/#{project_id}/sharing/#{user_id}"
+        end
+
+        # Edit user share of a project
+        #
+        # @param project_id [Integer] Id of project
+        # @param user_id [Integer] Id of user
+        # @return [Hashie::Mash] Updated share of project for user
+        def update_project_sharing_user project_id, user_id
+          put "projects/#{project_id}/sharing/#{user_id}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module BWAPI
+  class Client
+    module Projects
+      module Signals
+
+        # Get all signals belonging to user in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [Integer] page Page of projects to retrieve
+        # @option opts [Integer] pageSize Results per page of results
+        # @option opts [Integer] importance Importance of signal
+        # @option opts [String] type Type of signal
+        # @option opts [Integer] projectId Project id of the signal
+        # @option opts [Hash] filter The filter(s) to apply
+        # @return [Hashie::Mash] All signals for user in project
+        def signals id, opts
+          get "projects/#{id}/signals", opts
+        end
+
+        # Set the vote type and comment of a signal for a given user
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] userId Id of the user
+        # @option opts [Integer] voteType Type of vote
+        # @option opts [String] comment User comment
+        # @option opts [Integer] signalId Id of signal
+        # @option opts [Integer] projectId Project id of the signal
+        # @return [Hashie::Mash] Update signal for given user
+        def set_signal_vote id, opts
+          post "projects/#{project_id}/signals/vote", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Summary
+
+        # Summary of projects
+        #
+        # @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
+        # @option opts [String] :filter Filter to apply to the query
+        # @return [Hashie::Mash] Project summary information
+        def projects_summary opts={}
+          get "projects/summary", opts
+        end
+        alias :summary :projects_summary
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module BWAPI
+  class Client
+    module Projects
+      module Tags
+
+        # Get all tags in project
+        #
+        # @param id [Integer] Id of project
+        # @option opts [Integer] page Page of projects to retrieve
+        # @option opts [Integer] pageSize Results per page of results
+        # @return [Hashie::Mash] All tags in project
+        def tags id, opts={}
+          get "projects/#{id}/tags", opts
+        end
+
+        # Get a specific tag in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param tag_id [Integer] Id of tag
+        # @return [Hashie::Mash] Specific tag
+        def get_tag project_id, tag_id
+          get "projects/#{project_id}/tags/#{tag_id}"
+        end
+        alias :tag :get_tag
+
+        # Create a new tag in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the tag
+        # @option opts [String] name Name of the tag
+        # @return [Hashie::Mash] New tag
+        def create_tag id, opts
+          post "projects/#{id}/tags", opts
+        end
+
+        # Update an existing tag in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param tag_id [Integer] Id of tag
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the tag
+        # @option opts [String] name Name of the tag
+        # @return [Hashie::Mash] Updated tag
+        def update_tag project_id, tag_id, opts
+          put "projects/#{project_id}/tags/#{tag_id}", opts
+        end
+
+        # Delete an existing tag in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param tag_id [Integer] Id of tag
+        # @return [Hashie::Mash] Deleted tag
+        def delete_tag project_id, tag_id
+          delete "projects/#{project_id}/tags/#{tag_id}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module BWAPI
+  class Client
+    module Projects
+      module Users
+
+        # Get all users shared with project
+        #
+        # @param id [Integer] Id of project
+        # @return [Hashie::Mash] All users shared to project
+        def project_users id
+          get "projects/#{id}/users"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module BWAPI
+  class Client
+    module Projects
+      module Workflow
+
+        # Get all workflow categories for project
+        #
+        # @param id [Integer] Id of project
+        # @return [Hashie::Mash] Workflow categories for project
+        def workflow id
+          get "projects/#{id}/workflow"
+        end
+
+      end
+    end
+  end
+end

data/lib/bwapi/client/query_validation.rb

@@ -0,0 +1,27 @@
+module BWAPI
+  class Client
+    module QueryValidation
+
+      # Check to see if a query string is valid
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] query Query string
+      # @option opts [Array] language Languages for query string
+      # @return [Hashie::Mash] Query string validation results
+      def query_validation opts
+        get "query-validation", opts
+      end
+
+      # Check to see if a search within query string is valid
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] query Query string
+      # @option opts [Array] language Languages for query string
+      # @return [Hashie::Mash] Query string validation results
+      def search_within opts
+        get "query-validation/searchwithin", opts
+      end
+
+    end
+  end
+end

data/lib/bwapi/client/sso.rb

@@ -0,0 +1,18 @@
+module BWAPI
+  class Client
+    module SSO
+
+      # Authorize another user for access
+      #
+      # @note must have sso oauth_token
+      # @see oauth_token
+      #
+      # @param user_id [Integer] The user id
+      # @return [Hashie::Mash] User authorization
+      def sso id
+        get "sso/#{id}"
+      end
+
+    end
+  end
+end