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

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

@@ -1,10 +1,10 @@
+# encoding: utf-8
 module BWAPI
   class Client
     module Projects
       module StreamDashboards
         # Streams module for projects/stream_dashboards/streams endpoints
         module Streams
-
           # Get all streams in a stream dashboard
           #
           # @param project_id [Integer] Id of project
@@ -12,7 +12,7 @@ module BWAPI
           # @option opts [Integer] page Page of results to retrieve
           # @option opts [Integer] pageSize Results per page of results
           # @return [Hashie::Mash] All stream dashboards for project
-          def get_streams project_id, stream_dashboard_id
+          def get_streams(project_id, stream_dashboard_id)
             get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams"
           end
 
@@ -22,7 +22,7 @@ module BWAPI
           # @param stream_dashboard_id [Integer] Id of stream dashboard
           # @param stream_id [Integer] Id of the stream
           # @return [Hashie::Mash] Specific stream
-          def get_stream project_id, stream_dashboard_id, stream_id
+          def get_stream(project_id, stream_dashboard_id, stream_id)
             get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
           end
 
@@ -38,7 +38,7 @@ module BWAPI
           # @option opts [String] settings Settings of the stream
           # @option opts [String] lastModified Last modification date of stream
           # @return [Hashie::Mash] Specific stream
-          def create_stream project_id, stream_dashboard_id, opts={}
+          def create_stream(project_id, stream_dashboard_id, opts = {})
             post "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams", opts
           end
 
@@ -55,7 +55,7 @@ module BWAPI
           # @option opts [String] settings Settings of the stream
           # @option opts [String] lastModified Last modification date of stream
           # @return [Hashie::Mash] Updated stream
-          def update_stream project_id, stream_dashboard_id, stream_id, opts={}
+          def update_stream(project_id, stream_dashboard_id, stream_id, opts = {})
             put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}", opts
           end
 
@@ -65,10 +65,9 @@ module BWAPI
           # @param stream_dashboard_id [Integer] Id of stream dashboard
           # @param stream_id [Integer] Id of the stream
           # @return [Hashie::Mash] Deleted stream
-          def delete_stream project_id, stream_dashboard_id, stream_id
+          def delete_stream(project_id, stream_dashboard_id, stream_id)
             delete "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
           end
-
         end
       end
     end

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

@@ -1,9 +1,10 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Summary module for projects/summary endpoints
       module Summary
-
         # Summary of projects
         #
         # @param opts [Hash] options hash of parameters
@@ -11,12 +12,10 @@ module BWAPI
         # @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
+        def projects_summary(opts = {})
+          get 'projects/summary', opts
         end
-        alias :summary :projects_summary
-
       end
     end
   end
-end
+end

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

@@ -1,16 +1,17 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Tags module for projects/tags endpoints
       module Tags
-
         # Get all tags 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 tags in project
-        def tags project_id, opts={}
+        def tags(project_id, opts = {})
           get "projects/#{project_id}/tags", opts
         end
 
@@ -19,10 +20,9 @@ module BWAPI
         # @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
+        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
         #
@@ -31,7 +31,7 @@ module BWAPI
         # @option opts [Integer] id Id of the tag
         # @option opts [String] name Name of the tag
         # @return [Hashie::Mash] New tag
-        def create_tag project_id, opts={}
+        def create_tag(project_id, opts = {})
           post "projects/#{project_id}/tags", opts
         end
 
@@ -43,7 +43,7 @@ module BWAPI
         # @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={}
+        def update_tag(project_id, tag_id, opts = {})
           put "projects/#{project_id}/tags/#{tag_id}", opts
         end
 
@@ -52,11 +52,10 @@ module BWAPI
         # @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
+        def delete_tag(project_id, tag_id)
           delete "projects/#{project_id}/tags/#{tag_id}"
         end
-
       end
     end
   end
-end
+end

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

@@ -1,14 +1,15 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # TwitterQueries module for projects/twitterqueries endpoints
       module TwitterQueries
-
         # Get all twitter queries in a project
         #
         # @param project_id [Integer] Id of project
         # @return [Hashie::Mash] All twitter queries in project
-        def twitter_queries project_id
+        def twitter_queries(project_id)
           get "projects/#{project_id}/twitterqueries"
         end
 
@@ -17,10 +18,9 @@ module BWAPI
         # @param project_id [Integer] Id of project
         # @param query_id [Integer] Id of twitter query
         # @return [Hashie::Mash] Specific twitter query
-        def get_twitter_query project_id, query_id
+        def get_twitter_query(project_id, query_id)
           get "projects/#{project_id}/twitterqueries/#{query_id}"
         end
-        alias :twitter_query :get_twitter_query
 
         # Create a twitter query in a project
         #
@@ -46,7 +46,7 @@ module BWAPI
         # @option opts [String] twitterLimit Twitter limit
         # @option opts [String] twitterScreenName Twitter screen name
         # @return [Hashie::Mash] New twitter query
-        def create_twitter_query project_id, opts={}
+        def create_twitter_query(project_id, opts = {})
           post "projects/#{project_id}/twitterqueries", opts
         end
 
@@ -75,11 +75,10 @@ module BWAPI
         # @option opts [String] twitterLimit Twitter limit
         # @option opts [String] twitterScreenName Twitter screen name
         # @return [Hashie::Mash] Updated twitter query
-        def update_twitter_query project_id, query_id, opts={}
+        def update_twitter_query(project_id, query_id, opts = {})
           put "projects/#{project_id}/twitterqueries/#{query_id}", opts
         end
-
       end
     end
   end
-end
+end

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

@@ -1,18 +1,18 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Users module for projects/users endpoint
       module Users
-
         # Get all users shared with project
         #
         # @param project_id [Integer] Id of project
         # @return [Hashie::Mash] All users shared to project
-        def project_users project_id
+        def project_users(project_id)
           get "projects/#{project_id}/users"
         end
-
       end
     end
   end
-end
+end

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

@@ -1,18 +1,18 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       # Workflow module for projects/workflow endpoint
       module Workflow
-
         # Get all workflow categories for project
         #
         # @param project_id [Integer] Id of project
         # @return [Hashie::Mash] Workflow categories for project
-        def workflow project_id
+        def workflow(project_id)
           get "projects/#{project_id}/workflow"
         end
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/query_validation.rb

@@ -1,16 +1,17 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # QueryValidation module for queryValidation endpoints
     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
+      def query_validation(opts = {})
+        get 'query-validation', opts
       end
 
       # Check to see if a search within query string is valid
@@ -19,10 +20,9 @@ module BWAPI
       # @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
+      def search_within(opts = {})
+        get 'query-validation/searchwithin', opts
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/sso.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # SSO module for sso endpoint
     module SSO
-
       # Authorize another user for access
       #
       # @note must have sso oauth_token
@@ -10,10 +11,9 @@ module BWAPI
       #
       # @param user_id [Integer] The user id
       # @return [Hashie::Mash] User authorization
-      def sso user_id
+      def sso(user_id)
         get "sso/#{user_id}"
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/test_search.rb

@@ -1,15 +1,16 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # TestSearch module for testSearch endpoint
     module TestSearch
-
-      # TODO: Uncomment once the endpoint has been fixed
       # Retrieve full text for a given url
-      #def test_search_content opts
-      #  get "testsearch/content", opts
-      #end
-      #alias :test_search :test_search_content
-
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] url the url to test search
+      # @return [Hashie::Mash] full text of the url
+      def test_search_content(opts = {})
+        get 'testsearch/content', opts
+      end
     end
   end
-end
+end

data/lib/bwapi/client/user.rb

@@ -1,15 +1,16 @@
+# encoding: utf-8
+
 require 'bwapi/client/user/notifications'
 
 module BWAPI
   class Client
     # User module for user endpoints and helper methods
     module User
-
       # Get the current user
       #
       # @return [Hashie::Mash] User information
       def user
-        get "user"
+        get 'user'
       end
 
       # Update the current user
@@ -34,8 +35,8 @@ module BWAPI
       # @option opts [String] mobile The users mobile number
       # @option opts [Date] creationDate Date the user was created on
       # @return [Hashie::Mash] Updated user information
-      def update_user opts={}
-        put "user", opts
+      def update_user(opts = {})
+        put 'user', opts
       end
 
       # Get users api role
@@ -53,7 +54,6 @@ module BWAPI
       end
 
       include BWAPI::Client::User::Notifications
-
     end
   end
-end
+end

data/lib/bwapi/client/user/notifications.rb

@@ -1,17 +1,18 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module User
       # Notifications module for projects/notifications endpoints
       module Notifications
-
         # Get the current user notifications
         #
         # @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] User notifications
-        def notifications opts={}
-          get "user/notifications", opts
+        def notifications(opts = {})
+          get 'user/notifications', opts
         end
 
         # Update users existing notifications
@@ -19,19 +20,18 @@ module BWAPI
         # @param opts [Hash] options Hash of parameters
         # @option opts [Array] list User notifications to be edited
         # @return [Hashie::Mash] Updated user notifications
-        def update_notification opts={}
-          put "user/notifications", opts
+        def update_notification(opts = {})
+          put 'user/notifications', opts
         end
 
         # Delete a users existing notification
         #
         # @param notification_id [Integer] Id of notification
         # @return [Hashie::Mash] Deleted user notifications
-        def delete_notification notification_id
+        def delete_notification(notification_id)
           delete "user/notifications/#{notification_id}"
         end
-
       end
     end
   end
-end
+end

data/lib/bwapi/configuration.rb

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 require 'logger'
 require 'faraday'
 
 module BWAPI
   # Configuration module to set default and custom client credentials
   module Configuration
-
     OPTION_KEYS = [
       :api_endpoint,
       :user_agent,
@@ -29,9 +30,9 @@ module BWAPI
     DEFAULT_CLIENT_ID     = 'brandwatch-api-client'
     DEFAULT_USER_AGENT    = "BWAPI Ruby Gem #{BWAPI::VERSION}".freeze
     DEFAULT_NETRC_FILE    = File.join(ENV['HOME'], '.netrc')
-    DEFAULT_LOGGER_FILE   = Logger.new("#{Dir::pwd}/bwapi.log")
+    DEFAULT_LOGGER_FILE   = Logger.new("#{Dir.pwd}/bwapi.log")
 
-    attr_accessor *OPTION_KEYS
+    attr_accessor(*OPTION_KEYS)
 
     # Extend hook
     def self.extended(base)
@@ -45,7 +46,7 @@ module BWAPI
 
     # Convert option_keys to hash and return
     def options
-      OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
+      OPTION_KEYS.reduce({}) { |a, e| a.merge!(e => send(e)) }
     end
 
     # Reset the configuration options
@@ -66,6 +67,5 @@ module BWAPI
       self.debug               = false
       self.log                 = DEFAULT_LOGGER_FILE
     end
-
   end
-end
+end