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

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

@@ -1,16 +1,17 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module Queries
         # DateRange module for projects/queries/dateRange endpoints
         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
+          def date_ranges(project_id, query_id)
             get "projects/#{project_id}/queries/#{query_id}/date-range"
           end
 
@@ -20,7 +21,7 @@ module BWAPI
           # @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 get_date_range project_id, query_id, date_range_id
+          def get_date_range(project_id, query_id, date_range_id)
             get "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
           end
 
@@ -33,7 +34,7 @@ module BWAPI
           # @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={}
+          def create_date_range(project_id, query_id, opts = {})
             post "projects/#{project_id}/queries/#{query_id}/date-range", opts
           end
 
@@ -48,7 +49,7 @@ module BWAPI
           # @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, date_range_id, opts={}
+          def update_date_range(project_id, query_id, date_range_id, opts = {})
             put "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}", opts
           end
 
@@ -58,12 +59,11 @@ module BWAPI
           # @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}/queries/#{query_id}/date-range/#{date_range_id}"
+          def delete_date_range(project_id, query_id, date_range_id)
+            delete "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
           end
-
         end
       end
     end
   end
-end
+end

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

@@ -1,21 +1,19 @@
+# encoding: utf-8
 module BWAPI
   class Client
     module Projects
       module Queries
         # Mentions module for projects/queries/mentions endpoints
         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
+          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
           #
@@ -28,7 +26,7 @@ module BWAPI
           # @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={}
+          def update_query_mention(project_id, query_id, mention_id, opts = {})
             patch "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
           end
 
@@ -43,12 +41,11 @@ module BWAPI
           # @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={}
+          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
+end

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

@@ -1,16 +1,16 @@
+# encoding: utf-8
 module BWAPI
   class Client
     module Projects
       # QueryGroups module for projects/queryGroups endpoints
       module QueryGroups
-
         # Get all query groups in project
         #
         # @param project_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 project_id, opts={}
+        def query_groups(project_id, opts = {})
           get "projects/#{project_id}/querygroups", opts
         end
 
@@ -19,10 +19,9 @@ module BWAPI
         # @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
+        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
         #
@@ -35,7 +34,7 @@ module BWAPI
         # @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 project_id, opts={}
+        def create_query_group(project_id, opts = {})
           post "projects/#{project_id}/querygroups", opts
         end
 
@@ -51,7 +50,7 @@ module BWAPI
         # @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={}
+        def update_query_group(project_id, query_group_id, opts = {})
           put "projects/#{project_id}/querygroups/#{query_group_id}", opts
         end
 
@@ -60,11 +59,10 @@ module BWAPI
         # @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
+        def delete_query_group(project_id, query_group_id)
           delete "projects/#{project_id}/querygroups/#{query_group_id}"
         end
-
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'bwapi/client/projects/rules/backfill'
 require 'bwapi/client/projects/rules/copy'
 
@@ -6,7 +7,6 @@ module BWAPI
     module Projects
       # Rules module for projects/rules endpoints
       module Rules
-
         # Get all rules in project
         #
         # @param project_id [Integer] The id of project
@@ -16,7 +16,7 @@ module BWAPI
         # @option opts [Integer] page Page Number of results to retrieve
         # @option opts [Integer] pageSize Results per page of results
         # @return [Hashie::Mash] All rules in project
-        def rules project_id, opts={}
+        def rules(project_id, opts = {})
           get "projects/#{project_id}/rules", opts
         end
 
@@ -25,10 +25,9 @@ module BWAPI
         # @param project_id [Integer] id The id of project
         # @param rule_id [Integer] id The id of rule
         # @return [Hashie::Mash] Specific rule
-        def get_rule project_id, rule_id
+        def get_rule(project_id, rule_id)
           get "projects/#{project_id}/rules/#{rule_id}"
         end
-        alias :rule :get_rule
 
         # Create a new rule in project
         #
@@ -43,7 +42,7 @@ module BWAPI
         # @option opts [String] queryName The query name the rule is applied to
         # @option opts [String] projectName The project name the rule is applied to
         # @return [Hashie::Mash] New rule
-        def create_rule project_id, opts={}
+        def create_rule(project_id, opts = {})
           post "projects/#{project_id}/rules", opts
         end
 
@@ -60,7 +59,7 @@ module BWAPI
         # @option opts [String] queryName The query name the rule is applied to
         # @option opts [String] projectName The project name the rule is applied to
         # @return [Hashie::Mash] Updated rule
-        def update_rule project_id, rule_id, opts={}
+        def update_rule(project_id, rule_id, opts = {})
           put "projects/#{project_id}/rules/#{rule_id}", opts
         end
 
@@ -69,14 +68,13 @@ module BWAPI
         # @param project_id [Integer] Id The project id
         # @param rule_id [Integer] Id The rule id
         # @return [Hashie::Mash] Deleted rule
-        def delete_rule project_id, rule_id
+        def delete_rule(project_id, rule_id)
           delete "projects/#{project_id}/rules/#{rule_id}"
         end
 
         include BWAPI::Client::Projects::Rules::Backfill
         include BWAPI::Client::Projects::Rules::Copy
-
       end
     end
   end
-end
+end

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

@@ -1,21 +1,21 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module Rules
         # Backfill module for projects/rules/backfill endpoint
         module Backfill
-
           # Create a backfill for a rule in project
           #
           # @param project_id [Integer] id The id of project
           # @param rule_id [Integer] id The id of rule
           # @return [Hashie::Mash] Specific rule backfill
-          def create_rule_backfill project_id, rule_id
+          def create_rule_backfill(project_id, rule_id)
             post "projects/#{project_id}/rules/#{rule_id}/backfill"
           end
-
         end
       end
     end
   end
-end
+end

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

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module Rules
         # Backfill module for projects/rules/copy endpoint
         module Copy
-
           # Copy a rule to another project
           #
           # @param project_id [Integer] id The id of project
@@ -12,12 +13,11 @@ module BWAPI
           # @param opts [Hash] options Hash of parameters
           # @option opts [Integer] copyToProjectId the target project id
           # @return [Hashie::Mash] New rule created in project
-          def create_rule_copy project_id, rule_id, opts={}
+          def create_rule_copy(project_id, rule_id, opts = {})
             post "projects/#{project_id}/rules/#{rule_id}/copy", opts
           end
-
         end
       end
     end
   end
-end
+end

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

@@ -1,16 +1,16 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Sharing module for projects/sharing endpoints
       module Sharing
-
         # Default shares of a project
         #
         # @return [Hashie::Mash] Default project shares information
         def default_project_sharing
-          get "projects/sharing"
+          get 'projects/sharing'
         end
-        alias :sharing :default_project_sharing
 
         # Shares of a project
         #
@@ -18,7 +18,7 @@ module BWAPI
         # @param opts [Hash] options hash of parameters
         # @options opts [Boolean] sharedOnly Boolean flag to return only shared shares (default: false)
         # @return [Hashie::Mash] Specific project shares
-        def project_sharing project_id, opts={}
+        def project_sharing(project_id, opts = {})
           get "projects/#{project_id}/sharing", opts
         end
 
@@ -28,7 +28,7 @@ module BWAPI
         # @param opts [Hash] options hash of parameters
         # @options opts [Array] ProjectShareDTO Shares to be edited
         # @return [Hashie::Mash] Updated project shares
-        def update_project_sharing project_id, opts={}
+        def update_project_sharing(project_id, opts = {})
           put "projects/#{project_id}/sharing", opts
         end
 
@@ -37,7 +37,7 @@ module BWAPI
         # @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
+        def project_sharing_user(project_id, user_id)
           get "projects/#{project_id}/sharing/#{user_id}"
         end
 
@@ -47,11 +47,10 @@ module BWAPI
         # @param user_id [Integer] Id of user
         # @options opts [Hash] User share to be edited
         # @return [Hashie::Mash] Updated share of project for user
-        def update_project_sharing_user project_id, user_id, opts={}
+        def update_project_sharing_user(project_id, user_id, opts = {})
           put "projects/#{project_id}/sharing/#{user_id}", opts
         end
-
       end
     end
   end
-end
+end

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

@@ -1,9 +1,10 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Signals module for projects/signals endpoints
       module Signals
-
         # Get all signals belonging to user in project
         #
         # @param project_id [Integer] Id of project
@@ -15,7 +16,7 @@ module BWAPI
         # @option opts [String] type Type of signal
         # @option opts [Hash] filter The filter(s) to apply
         # @return [Hashie::Mash] All signals for user in project
-        def signals project_id, opts={}
+        def signals(project_id, opts = {})
           get "projects/#{project_id}/signals", opts
         end
 
@@ -28,11 +29,10 @@ module BWAPI
         # @option opts [String] comment User comment
         # @option opts [Integer] signalId Id of signal
         # @return [Hashie::Mash] Update signal for given user
-        def set_signal_vote project_id, opts={}
+        def set_signal_vote(project_id, opts = {})
           post "projects/#{project_id}/signals/vote", opts
         end
-
       end
     end
   end
-end
+end

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/projects/stream_dashboards/streams'
 
 module BWAPI
@@ -5,7 +7,6 @@ module BWAPI
     module Projects
       # StreamDashboards module for projects/stream_dashboards endpoints
       module StreamDashboards
-
         # Get all stream dashboards in project
         #
         # @param project_id [Integer] Id of project
@@ -13,7 +14,7 @@ module BWAPI
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
         # @return [Hashie::Mash] All stream dashboards for project
-        def stream_dashboards project_id, opts={}
+        def stream_dashboards(project_id, opts = {})
           get "projects/#{project_id}/streamDashboards", opts
         end
 
@@ -24,7 +25,7 @@ module BWAPI
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
         # @return [Hashie::Mash] All stream dashboards summary for project
-        def get_stream_dashboards_summary project_id
+        def get_stream_dashboards_summary(project_id)
           get "projects/#{project_id}/streamDashboards/summary"
         end
 
@@ -33,7 +34,7 @@ module BWAPI
         # @param project_id [Integer] Id of project
         # @param stream_dashboard_id [Integer] Id of stream dashboard
         # @return [Hashie::Mash] Stream dashboard complete with streams
-        def get_stream_dashboard_complete project_id, stream_dashboard_id
+        def get_stream_dashboard_complete(project_id, stream_dashboard_id)
           get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/complete"
         end
 
@@ -42,7 +43,7 @@ module BWAPI
         # @param project_id [Integer] Id of project
         # @param stream_dashboard_id [Integer] Id of stream dashboard
         # @return [Hashie::Mash] Stream dashboard
-        def get_stream_dashboard project_id, stream_dashboard_id
+        def get_stream_dashboard(project_id, stream_dashboard_id)
           get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}"
         end
 
@@ -55,7 +56,7 @@ module BWAPI
         # @option opts [String] created The stream creation date
         # @option opts [String] filter the stream filter
         # @return [Hashie::Mash] New stream dashboard
-        def create_stream_dashboard project_id, opts={}
+        def create_stream_dashboard(project_id, opts = {})
           post "projects/#{project_id}/streamDashboards", opts
         end
 
@@ -69,7 +70,7 @@ module BWAPI
         # @option opts [String] created The stream creation date
         # @option opts [String] filter the stream filter
         # @return [Hashie::Mash] Updated stream dashboard
-        def update_stream_dashboard project_id, stream_dashboard_id, opts={}
+        def update_stream_dashboard(project_id, stream_dashboard_id, opts = {})
           put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}", opts
         end
 
@@ -77,13 +78,12 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param stream_dashboard_id [Integer] Id of stream dashboard
-        def delete_stream_dashboard project_id, stream_dashboard_id
+        def delete_stream_dashboard(project_id, stream_dashboard_id)
           delete "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}"
         end
 
         include BWAPI::Client::Projects::StreamDashboards::Streams
-
       end
     end
   end
-end
+end